fullfilment-ux

PATCH – Confirm Delivery

This method is used to confirm the delivery of a preorder device to B2BSoft.

URL

https://[localhost]:[port]/fullfilment-ux/v1/{businessId}/shipment/{id}

URL Param

Header

cURL request

curl --location --request PATCH 'https://nonprod.esb.cloud.lla.com/dev/fullfilment-ux/fullfilment-ux/v1/PR/shipment/1234567' \
--header 'client_id: 12345' \
--header 'client_secret: abcde' \
--header 'X-Correlation-ID: {{guid}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shipmentItem": {
        "id": 1,
        "product": {
            "productSerialNumber": "SN987654321"
        }
    },
    "characteristic": [
        {
            "name": "deliveryConfirmation",
            "value": true,
            "valueType": "boolean"
        }
    ],
    "deliveryDate": "2026-07-01T12:30:00Z"
}'

Definitions

Each of the request body parameters is detailed.

Response

{
    "id": "1234567",
    "description": "Delivery confirmed"
}

Response Field Definitions

Delivery Validation Conditions

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "The request is invalid or not properly formed.",
      "description" : "Malformed request syntax, invalid request message framing, or deceptive request routing."
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials.

{
  "errors" : [{
      "code" : 403,
      "message" : "The user is not authorized to perform this operation.",
      "description" : "The server understood the request but refuses to authorize it."
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be a temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
  "errors" : [{
      "code" : 405,
      "message" : "APIKIT:METHOD_NOT_ALLOWED",
      "description" : "HTTP Method POST not allowed for : /{businessId}/shipment/{id}"
    }]
}

[ 409 ]

Conflict - The request cannot be processed due to a conflicting delivery state. This occurs when sending deliveryConfirmation=true for an already confirmed transaction, or sending deliveryConfirmation=false after a confirmed delivery for the same posTransactionID (duplicate processing).

{
  "errors" : [{
      "code" : 409,
      "message" : "Conflict",
      "description" : "Delivery confirmation already processed for provided transaction"
    }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "Internal Server Error",
      "description" : "The request failed due to an internal error"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation PATCH /shipment/{id} for Business Id: xxxx not implemented"
    }]
}